[DOCS] Expand info on Makefile, uv, prek and code quality#3081
Open
jbampton wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the contributor documentation for building Sedona docs locally and running code-quality checks, focusing on using the repository Makefile together with uv and prek.
Changes:
- Adds a “Compiling via Makefile” section that documents
make docsbuildand explains its steps. - Reworks/expands the “Code Quality Checks with
prek,uv, andmake” section, including a standalone (non-Makefile) flow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **What this command does behind the scenes:** | ||
|
|
||
| 1. **Environment Verification:** Validates that `uv` is available on your local path. | ||
| 2. **Dependency Syncing:** Runs `uv sync --all-groups` to automatically set up or synchronize an isolated virtual environment (`.venv`) containing MkDocs and compilation dependencies. |
| To keep linter definitions synchronized with upstream styling configurations without a `Makefile` shortcut, trigger an explicit update through the core engine: | ||
|
|
||
| ```bash | ||
| uv run prek autoupdate |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Did you read the Contributor Guide?
Is this PR related to a ticket?
[DOCS] my subjectWhat changes were proposed in this PR?
Add more info on how our systems work for docs and code quality.
Let us help people use the tools correctly on their local machines.
How was this patch tested?
Did this PR include necessary documentation updates?